Schema framework and a method and apparatus for normalizing schema

ABSTRACT

The schema framework of the present invention is a set of rules and best practices that a user follows when creating schema in accordance with the present invention. By following these rules, schema are produced that can be used, reused, and managed in a distributed computing environment, thus reducing the time and effort associated with creating instance documents. Certain rules govern the content and format of the schema namespaces. Each schema namespace includes a category identifier that identifies a category to which the schema associated with the namespace relates. Once an instance document has been published by storing it in a schema repository, the schema and the namespace associated with that schema are “frozen” and cannot be changed. By freezing the schema and namespace, the schema and namespace become standardized, which facilitates instance document generation, validation, and use across a distributed system.

CROSS REFERENCE TO RELATED APPLICATION

This application is a divisional application of U.S. patent applicationSer. No. 11/930,569 filed Oct. 31, 2007, which is a divisionalapplication of U.S. patent application Ser. No. 10/865,519 filed on Jun.10, 2004, which claims priority to U.S. Provisional Patent ApplicationSer. No. 60/477,530, filed Jun. 11, 2003. These patent applications arehereby incorporated herein by reference in their entireties for allpurposes.

FIELD OF THE INVENTION

The present invention relates generally to markup language schema, andmore particularly, to a schema framework and a method and apparatus fornormalizing schema to ensure that they conform to the framework.

BACKGROUND OF THE INVENTION

Extensible Markup Language (XML) is specification developed by the WorldWide Web Consortium (“WC3”). XML has become increasingly more importantin the exchange of data and documents (“XML documents”) on the Web andelsewhere. XML allows designers to create their own data and documentformats (“formats”). XML formats are customized tags, enabling thedefinition, transmission, validation, and interpretation of data betweenapplications and between organizations. Schemas define XML formats. TheW3C, OASIS, and other organizations have published specifications forcreating schemas (e.g., the W3C′s XML DTDs and XML Schema, and OASIS'Relax NG). There is, however, no specification that describes howdesigners can manage schemas on a large scale and within a standardschema framework.

Therefore, there exists in the industry a need for a system thatfacilitates the ongoing and consistent creation, management, and use ofmultiple schemas and versions of schemas over time. Further needs existfor a set of best practices and methodology for developing XML schemasthat provide version control, unique schema identifiers, schemamanagement and maintenance over time, and consistent publishing rulesfor schema discovery and documentation.

SUMMARY OF THE INVENTION

The schema framework of the present invention is a set of rules and bestpractices that a user follows when creating schema in accordance withthe present invention. By following these rules, schema are producedthat can be used, reused, and managed in a distributed computingenvironment, thus reducing the time and effort associated with creatingand using schema and instance documents based on the schema. Certainrules govern the content and format of the schema namespaces. Eachschema namespace includes a category identifier that identifies acategory to which the schema associated with the namespace relates. Oncean instance document based on the schema has been published in a schemarepository, the schema and the namespace associated with that schema are“frozen” and cannot be changed. By freezing the schema and namespace,the schema and namespace become standardized, which facilitates instancedocument generation, validation, and use across a distributed system.

In addition, the namespace category identifier makes it possible togroup schema in the repository by subject matter, which allows schema tobe more easily searched, retrieved and managed from distributed schemarepositories. This also facilitates instance document generation acrossa distributed system. Each namespace includes a category identifier thatidentifies a subject matter, such as, for example, a geographical regionidentifier, a legal jurisdiction identifier, a person, an address, adocument type, a form type, and an organization identifier. Thegeographical identifier may identify a geographical or other location ora place. The organization identifier may identify a social or commercialorganization, an institution, a department, an agency, an industry, etc.Preferably, a category identifier has a subject matter meaning that iscommonly understood by humans so that understanding the categoryidentifier is easy and so that reuse and management of schema isencouraged.

These and other features and advantages of the present invention willbecome apparent from the following description, drawings and claims.

BRIEF DESCRIPTION OF THE DRAWINGS

FIG. 1 is a block diagram representation of a system for developing andmanaging schema and XML documents in accordance with an exemplaryembodiment of the present invention.

FIG. 2 is a block diagram representation of a schema framework of FIG.1.

FIG. 3 is a block diagram representation of a schema repository of FIG.1.

FIG. 4 is a block diagram representation of a schema generator of FIG.1.

FIG. 5 is a block diagram representation of a code generator of FIG. 1.

FIG. 6 is a block diagram representation of a wizard of FIG. 1.

FIG. 7 is a block diagram representation of an editor of FIG. 1.

DETAILED DESCRIPTION OF THE PREFERRED EMBODIMENTS

Referring now to the drawing figures, in which like reference numbersrefer to like parts throughout the several views, preferred forms of thepresent invention will now be described by way of example embodiments.It is to be understood that the embodiments described and depictedherein are only selected examples of the many and various forms that thepresent invention may take, and that these examples are not intended tobe exhaustive or limiting of the claimed invention. Also, as used in thespecification including the appended claims, the singular forms “a,”“an,” and “the” include the plural unless the context clearly dictatesotherwise.

FIG. 1 depicts a block diagram of a system 100 for developing andmanaging schema and using the schema to author and manage content inaccordance with an exemplary embodiment of the present invention.Preferably, the system 100 comprises a schema development and managementsubsystem 105 and a content authoring, management and electronic filingsubsystem 110.

The schema development and management subsystem 105 comprises a schemaframework 115 that describes rules that govern the operation of a schemarepository 120, a schema generator 125, and a code generator 130. Theschema repository 120 and the schema generator 125 communicate betweeneach other and with the code generator 130. Schema output from theschema development and management subsystem 105 are used as input forthe content authoring, management, and electronic filing subsystem 110.Additionally, schema output from the schema development and managementsubsystem can be recycled for reuse in the schema development andmanagement subsystem. As an example, schema output from the schemagenerator 125 can be used as input for the code generator 130. The codegenerator, in turn, communicates with the content authoring, management,and electronic filing subsystem 110.

The content authoring, management, and electronic filing subsystem 110comprises a wizard 140 for editing forms, an editor 145 for editingdocuments, a viewer and indexer 150, an electronic filing module 155,and a document repository 160. The content authoring, management, andelectronic filing subsystem 110 can also comprise external applicationsoftware 165.

The Schema Framework

The schema framework 115 provides a set of rules, or best practices, fordeveloping schemas 200 that can be used to create messages 205, forms210, and documents 215, as depicted in FIG. 2. Preferably, the schemasuse the W3C XML Schema 1.0 as a basis for creating the schema framework115. However, other types or versions of schemas could be used, such asa future version of W3C XML Schema or OASIS' RELAX NG Schema.

Namespaces

Preferably, the schemas use namespaces 220 to distinguish the context ofXML elements that have the same name but that have different meanings.An XML namespace is generally defined as a collection of names,identified by a URI reference, that are used in XML documents as elementtypes and attribute names. More preferably, the schemas 200 generatedthrough the schema framework 115 use meaningful namespaces 220 andmeaningful namespace prefixes as a form of version control. Preferably,the namespaces 220 are meaningful in that they convey to the user of thesystem 100 a description of the XML elements and thus provide anautomated way of discovering schema in Internet-based or local schemarepositories.

Namespaces 220 are declared in an XML document either as a targetnamespace, in which case the namespace prefix is not used, or as anon-target namespace, in which case the namespace prefix is used.Preferably, a “xsd:targetNamespace” is declared with a value equal tothe default namespace value.

The schema framework 115 distinguishes between two types of instancedocuments: (a) complex XML documents and (b) simple XML documents. In acomplex XML instance document, the namespace prefix prefixes allelements in the document, except that the root element may beunprefixed. That is, the prefix is separated from the element name by acolon. In Simple XML instance documents, a default namespace without aprefix is used on each module's intended root element, in which case thedefault context of its descendants are implied.

In an instance document, the namespace prefix precedes the element nameseparated by a colon or the namespace is declared on a parent element inwhich case the default context of its descendents are implied. Forexample, the following are preferred namespaces.

xmlns:Furniture=“http://www.xmllegal.org/Schema/xmlLegal/Furniture/01

xmlns:Document=“http://www.xmllegal.org/Schema/xmlLegal/Document/01

Thus, in these two examples, the namespace prefixes are “Furniture” and“Document”. It should be understood that the prefix is not the actualnamespace, but rather, the prefix is a mapping to it.

For example, the following attribute maps the “Address” prefix to anamespace (that happens to be a uniform resource identifier “URI”):

xmlns:Address=“http://www.XMLlegal.org/Schema/BuildingBlocks/Primitives/Address/01/”

In the next example, the prefix is the same, but the namespace isdifferent:

xmlns:Address=“http://www.XMLlegal.org/Schema/BuildingBlocks/Primitives/Address/02/”

The result is an element <Address:Line> in Instance Document One wherethe first namespace is used that has a different technical value thanthe same <Address:Line> element in Instance Document Two where thesecond namespace is used. Thus, the two elements are different, eventhough textually they appear the same (in instance documents, e.g.,<Address:Line> in a Complex XML document or <Line> in the “Address”context in a Simple XML document).

Thus, unlike other namespace regimes, the schema framework 115standardizes meaningful namespace prefixes. This provides a type ofhuman-readable categorization system for schemas. For example, the“Address” prefix is used for a category of schemas that representaddresses, although each address schema may be slightly different andmay be assigned a different namespace and a correspondingly differenceplace in a schema repository 120.

Thus, it can be said that a “genre” of schemas is “Address” but theremay be different types of addresses within the genre. In this way, thespecific “meaning” of a particular XML instance document can be tied tothe schema located at a repository location with the same namespace. Ifthe schema 200 is frozen, then this in turn “freezes” the meaning of theschema and all document instances associated with it. This provides agreat deal of flexibility in creating related schemas for similar butdifferent applications, while providing both a technical andhuman-readable means of understanding instance documents and mappinglike-schema to like-schema and like-meaning to like-meaning.

In exemplary embodiments, the prefix “Address” is a standard prefix foraddresses. There can be multiple namespaces associated with a singleprefix, which can distinguish meaning and provide version control.Preferably, all addresses, for example, use the “Address” prefix.

It should be noted that the list of standard prefixes, including but notlimited to, Phone, Email, Person, and Organization can expand. Thus, theschema framework 115 is designed to accommodate expansion and evolutionover time and to do so such that “meaning” can be fixed and discoveredin a mechanical way.

It should also be noted that multiple schema types can exist in the sameXML document (e.g., multiple Address formats used in the same document).If two address formats exist in the same document, then meaningfulprefixes can preferably be used that establish the distinction (e.g.,ShortAddress and LongAddress). Additionally, the schema framework 115can accommodate foreign language formats, which use a different prefixthat corresponds to the English word in the foreign language (e.g.,“Addresse” would be used for a German address).

Namespaces for Version Control

In the preferred embodiment, the schemas 200 generated through theschema framework 115 use meaningful namespaces 220 and meaningfulnamespace prefixes as a form of version control 225. Version control 225is important because in the software and technical standards industries,most products have multiple versions that are incremented over time. Itis useful to version XML schemas as well for at least three reasons: (1)in cases where an existing schema may be updated or replaced by a newschema; (2) in cases where there may be a need for two similar schemasto meet different requirements; and (3) in cases where there arelanguage differences such as foreign languages or even differences inthe English language (e.g., organization versus organisation).

Thus, version control 225 can be achieved with the use of uniquenamespaces 220. Namespaces are preferably URIs (i.e., uniform resourceindicators) that point to a location at the schema repository 120. Localand mirrored repositories can also be used, provided those repositoriespreferably follow the schema framework 115 rules for local and mirroredrepositories.

In a preferred embodiment, the namespace 220 is unique; the schemas 200are frozen upon publication of the first instance document; and theschema 200 can be programmatically discovered in the schema repository120 (or in the local or mirrored repository) based on the namespacestring.

Format of a Namespace

Namespaces 220 in the format 230 of a URI are preferably made of fourparts, although other organization is possible. In the preferredembodiment, the first part includes the string to a domain name, such asfor example, “http://www.xmllegal.org/”. The second part includes thestring “Schema/”. The third part is a logically-ordered string ofmeaningful subject matter, including jurisdictional, organizational, orgeographical names, preferably separated by a forward or backslash,depending on the nature of the directory. The fourth part is a numeralto indicate version. In some cases, the numeral to indicate version willsometimes precede the name of the schema as a grouping mechanism. Thenumeral to indicate version may be omitted in cases, such as forexample, where a primary schema imports secondary schemas and theprimary schema uses a numeral for version control. In such a case, thesecondary schemas can be located in subdirectories of the primary schemaand are, therefore, clearly versioned from others of like kind. In thepreferred embodiment, the numeral indicating version can be in any oneof the following formats, where X is a digit 0 to 9: XX; XXX; TestXX; orTestXXX, although other formats are possible. The numeral at the end ofthe namespace allows different versions of the same type of schema to beadopted in the same geographical location, organization, orjurisdictions.

Preferably, namespaces 220 and associated directory structures usefull-spelled, Upper Camel Case words, except for widely understoodabbreviations or acronyms (such as country codes), with no spaces,although namespaces 220 and directory structures can be created usingabbreviated or truncated names or acronyms and be within the scope ofthe present invention. The use of full-spelled Upper Camel Case wordsmakes namespaces and directory structures human-readable andaesthetically pleasing and also provides the ability to more efficientlydo mechanical human-language dictionary analysis and aggregation andcomparison of human-language synonyms.

In the preferred embodiment, the schema repository 120 uses adescriptive label, such as one describing a general subject matter ororganizational label, following the Part II “Schema/” string. Suchlabels include, for example, “Court”, “Transcripts”, “Justice”,“Healthcare”, “Automotive”, “Banking” or an organizational name, such as“xmlLegal”, “Microsoft”, or “DepartmentOfPublicSafety.” In the preferredembodiment, either before or following the subject matter ororganizational label, a two-letter ISO 3166 country code optionally canbe used. For example, “US” would be used for United States, or “AU” forAustralia. Additionally, in the preferred embodiment, after the countycode, the fully spelled state or province can be used. Optionally, atwo-letter abbreviation for the state or province can be used. After thestate or province name, a narrower geographic or jurisdictionalsubdivision, such as the county name, can be used. Different oradditional subdivisions can be used to further refine the applicabilityof the schema and be within the scope of the present invention.

Freezing a Schema in a Namespace

Instance documents can use namespaces 220 for version control 225because the schema (or schemas) corresponding to the instance documentcan be “frozen” once a document instance has been published.

Stated another way, “freezing a namespace” or describing a schema as“frozen” means that the schema located in one or more repositories andidentified by a unique identifier such as a unique namespace may nolonger be changed. Thus, preferably, a new schema or version of a schemaof a similar type uses a different unique identifier and can be locatedin a correspondingly different place in one or more mirrored schemarepositories. For example, a schema can be copied into another namespaceand the new schema in the new namespace can be altered. However, oncefrozen, the original schema preferably cannot be changed. If the schemawere to be changed after it was “frozen”, then the instance documentsbased on the changed schema potentially will not validate against theoriginal schema, which means that applications cannot rely on eitherschema and the system may not function properly.

Preferably, the schemas 200 are frozen once instance documents based onthose schemas are published to the schema repository 120 because once aninstance document is published and available to the world, the namespacein it will point back to the location in one or more schema repositorieswhere the schema on which it is based is located. If the schema ischanged at the position in the directory where the namespace points,then the instance documents based on the schema are not likely tovalidate against it, thus potentially causing interoperability problemsthat may cause the system to not function properly.

To overcome these shortcomings, a new version of the same schema can becreated and stored in a directory corresponding to a similar, but newnamespace. In this way, the integrity of published instance documents ismaintained indefinitely, while allowing new versions to be developed.

Namespace Declarations and Import Statements

In the preferred embodiment, namespaces are declared as attributes ofthe xsd:schema element using a standard namespace prefix appropriate tothe schema. The namespace prefix represents the genre of schemas beingcreated, such as, but not limited to, an Address, Phone, Email, Person,Organization, Weapon, Vehicle, =, Account, or Patient. New namespaceprefixes are added as desired and are preferably descriptive of theschema genre being described. Also preferably, the schemas can import anAttributes schema, which is a set of global attributes.

In the preferred embodiment, the namespace value is declared as anattribute in the xsd:schema element that matches the namespace declaredin the xsd:import element. The schema location attribute on thexsd:import element is preferably a relative path (rather than a hardcoded path) to a location in the schema repository directory structurebeginning with the directory “Schema.”

Conventions

For organizational purposes, the schema framework 115 preferably ordersschema constructs 245 as follows: complexTypes; simpleTypes; elements;and groups, although other ordering schemes are also within the scope ofthe present invention. The order of complexTypes and elements arepreferably in the order the element first appears in the schema, even ifthe element is only referenced. Regardless of how complexTypes areordered, in the preferred embodiment, the first complexType in theschema preferably has an attribute name value that is the same as theschema's namespace prefix, filename, and parent or grandparentdirectory, as described below, although other naming conventions arealso within the scope of the present invention.

The first complexType in the schema preferably corresponds to theelement intended to be the “root” element of the schema. The rootelement, the genre of the namespace prefix, the name of the schemafilename in the schema repository, and the name of the schema's parentdirectory or grandparent directory if a version number directory isused, are preferably the same string.

The value of the “name” attribute on all complexTypes is preferably theexact string as the corresponding element declaration. All complexTypespreferably use the Attributes:Global attributeGroup. ComplexTypes maycontain element references to internal, globally declared elements or toimported elements, but preferably do not include locally declared,non-unique elements. For example, if the element names are not uniquewithin the context of the namespace (which can happen with locallydeclared elements), then the system may not work properly. ComplexTypesare preferably declared globally, not locally to an element. SimpleTypesare preferably declared globally within the schema or imported fromanother schema.

Element and Attributes

XML information often sits just below the user interface. If named andstructured such that the names convey the content of the elements, thenames for elements 250 and attributes 255 can be taken directly from XMLand used as labels in the user interface. For example, by searching thestring “CaseName” for an uppercase character preceded by a lowercasecharacter, it is very easy to add a space that results in a readable andaesthetically pleasing user interface. This can be done with elementsthat use underscores for spaces and for Lower Camel Case. If, however,abbreviations are used as element names, then the use of them as labels,without additional translation encoding, can often be difficult orconfusing.

Thus, preferably, the element names have formats using uppercase lettersfor the first letter of each word (Upper Camel Case), although otherelement naming conventions are also within the scope of the presentinvention. One or all words in the element name can be programmaticallyor otherwise capitalized, which ultimately provides a visually pleasinguser interface. For example, the following are preferred formats forelement names: CourtFiling, FirstName, LastName, and City. Alsopreferably, the element names use no abbreviations. If, however, commonabbreviations are used, then the abbreviations are preferably documentedand listed in the schema's specification with the non-abbreviated formclearly documented.

In the preferred embodiment, elements 250 are preferably declaredglobally, not locally, as elements with no children elements except forelements used for documentation. (In the preferred embodiment, childelements can occur when using xsd:annotation or xsd:appinfo). Thus, allglobal elements are preferably unique to the schema and, hence, to thenamespace, and therefore every element in the schema repositorypreferably has a unique and distinct meaning. Elements 250 preferablyuse the “type” attribute. The value of the element's type attribute canbe either the name of a complexType declared in the schema, or the nameof a complexType declared in an imported schema. All elements 250preferably use, at least, the Attribute:Global group of attributes. Theglobal attributes are preferably declared in the element's correspondingcomplexType declaration. Elements used as children of other elements arereferenced in the intended parent's complexType.

Attributes 255 are preferably declared in an element's correspondingcomplexType as a local attribute. Also preferably, attributes 255 arenot declared globally and referenced. Any number of attributeGroupelements may be referenced. Attributes that are a simpleType preferablyuse the type attribute, consistent with the rule that simpleTypes arepreferably declared globally.

The Attributes:Global group preferably includes at least the followingattributes: ID (xsd:ID); Class (xsd:string); and Type (xsd:string),although other or additional attributes are also within the scope of thepresent invention.

Although it is possible to use minOccurs and maxOccurs in a variety ofways, the schema preferably do not use minOccurs and maxOccursattributes on content model declarations for choice, sequence, or all,although other conventions are also within the scope of the presentinvention. The schema also preferably do not use “nested” content modelswithin a schema. The group element may use minOccurs and maxOccurs. Itis possible to “nest” content models by either importing the intendedroot element of a schema or by referencing a group.

Normalization

Schemas can follow certain rules of construction. Schemas following therules of constructions are called “normalized” schemas, and the processof creating or ensuring that a schema is normalized is called“normalization.”

Schema “normalization” is an algorithm that represents a set of bestpractices and conventions used in the schema framework 115. In thepreferred embodiment, the algorithm functions such that an input schemais transformed into another representation and then transformed fromthat new representation into schema. The resulting schema should be avalid schema, should follow the rules of the schema framework, andshould validate the same instance documents as the original schema.Schema normalization is done in the schema framework 115 so that onestructure is used consistently in a number of schemas rather thanseveral structures used inconsistently in different schemas. That is,preferably, an Address schema that is normalized uses the same schemaconstructs and conventions as a Person schema. Normalization makes itmuch easier for developers to understand and develop code for schemasand instance documents based on schemas, to manage schemas, as well asto develop new schemas.

Modularity

The schema framework 115 preferably uses modular XML schemas as buildingblocks to build other, more complex schemas, messages, protocols, forms,and documents. XML schemas 200 and XML namespaces 220 provide an easiertechnical means of creating “modular” schemas as compared to creatingone large schema to describe an XML format. Modularity in XML schemasallows certain parts of the schema 200 to be used in other schemadefinitions and applications. Reuse of a schema module allows developersto build objects around schema modules and reuse code. Reuse of codespeeds development and encourages standardization.

Thus, preferably, the schemas in the schema framework 115 are modular.For example, a schema describing a Person may include import Address,Phone, and Email schemas. A schema describing a Vehicle may include aRegisteredOwner that may be a Person or an Organization. In each case,each schema preferably is a separate schema module. Complex schemas mayhave several modules.

The namespace prefix plus the name of the element, read together, shouldhave a human-language meaning appropriate to the genre of the schema.For example, if the schema genre (e.g., namespace prefix) is “Person”,then the following prefix/element name combinations are preferable forthe “Person” schema:Person:Name; Person:FirstName; Person:LastName; andPerson:Address.

In the preferred embodiment, the root element of a schema may beimported and used in another schema in one of two ways: use in elementdeclaration type attribute or use in element reference name attribute.Also preferably, only the “intended root element” of a schema or groupswithin a schema may be imported into another schema. That is, the entire“noun” or “object” is preferably used in the case of a root element orspecified groups of elements. Other conventions are also within thescope of the present invention

Construction

Preferably, the schema framework 115 distinguishes the following:individual elements; base primitives; two-level primitives; multi-levelprimitives; protocols; messages; forms; and documents. An individualelement is an XML element. An XML element can have a tag name such as“City.” An example of an XML element is <City>Sydney</City>.

A base primitive is an XML schema module that logically groups a numberof elements. For example, an Address is a base primitive that mayinclude the elements “Line,” “City,” “State,” “PostalCode,” and“Country.” In a preferred embodiment, per the normalization rules above,all schemas import an Attributes.xsd that includes global attributes.Thus, in a preferred embodiment, a Base Primitive, by definition,imports only an Attributes.xsd, but does not import any other schema.

A two-level primitive is a primitive constructed from more than one baseprimitive. For example, a “Person” may be constructed using the schemamodules “Address”, “Phone”, and “Email.” Multi-level primitives (schema)are schema constructed from several base, two-level, or othermulti-level primitives. For example, a “Vehicle” may include aregistered owner that would be a “Person” or an “Organization.” ThePerson and Organization schemas are themselves two-level primitives; andtherefore, Vehicle becomes a multi-level schema. These namingconventions are not necessary for the proper functioning of the schemaframework, but serve to define a vocabulary that allows users tomeaningfully describe interrelated sets of schema.

Messages 205 and protocols are constructed from elements and base,two-level, and multi-level primitives. There is a fine line between aprotocol and a message. Indeed, the line may be so blurred that there islittle distinction. In its purest form, a message is a transfer of datafrom one information system to another information system. A protocol isa message or a series of messages that invokes a subsequent response(e.g., an acknowledgement) or some other workflow. In practice, mostmessages require some sort of response, so a message is usually part ofa protocol and could be considered one and the same.

Like messages, forms 210 are constructed from elements and base,two-level, and multi-level primitives. A form is preferably combinedwith a stylesheet so that it is easy for a human to read. “Forms” aredistinguished from “documents” by the lack of free-form prose. Forms 210consist of data elements and corresponding labels arranged in a logicaland aesthetically pleasing document. Forms 210 may have “memo” fieldsfor long answers to specific questions, but do not generally includelong free-form prose, although other hybrid form-documents are alsowithin the scope of the present invention. In the schema framework 115,additional rules can be specified for forms. For example, the schemaframework 115 can use the following conventions to create specialformats for forms 210:

The root element of a form is “[General Descriptive Word]”.

The first child of the root element is <Head>.

The second child of the root element is <Body>.

An optional third child of the root element is <Signature>.

In this example, <Head> is invisible metadata, <Body> is visibleinformation on a form, and <Signature> is information for a digitalsignature.

In the preferred embodiment, the root element can optionally be createdby a “container” schema located within the namespace of the schema thatis the first child of the body of the form. For example:<http://www.xmllegal.org/Schema/Court/US/Georgia/Douglas/Juvenile/Form90/01/><http://www.xmllegal.org/Schema/Court/US/Georgia/Douglas/Juvenile/Form90/01/Legal/>

The head element preferably includes metadata about the form 210 thatwould not typically be included in the styled representation of the form(i.e., it would not appear on the face of the form for the humanreader). The head element preferably includes, but is not limited to,the following schemas: DocumentSummary; DocumentStatistics;DocumentVersion; DocumentProperties; and DocumentWorkflow. Other meansof incorporating form metadata are also within the scope of the presentinvention. Preferably, the head element for all forms 210 is common or,at least, very similar. The stylesheet for the form 210 can be includedwithin the form or can be a reference to a separate file. The bodyelement's first, and preferably only, child includes the unique schemathat make up the form.

Documents 215 are constructed from elements and base, two-level, andmulti-level primitives. Like forms, a document 215 can be combined witha stylesheet so that it is easy for a human to read. Like forms, adocument 215 can include a head, a body, and an optional signature.Unlike forms, documents 215 include free-form prose (or “unstructuredtext”) that requires special document-specific primitives. In the schemaframework 115, the head, body, and signature elements can operate in thesame way for both forms and documents. The body of a document, however,differs from the body of a form.

The body of an document preferably includes (1) frontmatter; (2) a body,or body elements, that include as descendants paragraphs, headings,outlines and optionally tables and objects (graphics, pictures,controls), and (3) backmatter. Paragraphs, headings, outlines, andtables include within them “flattened” inline vocabulary.

Frontmatter and backmatter usually include information that isstructured like a form. For instance, a court document usually has acaption with the name of the court, the names of the parties, a civilaction number, and a title. Likewise, a contract usually has a title,date, names of parties, and recitals. For each type of document, theinformation in the frontmatter and backmatter is preferably different,but all documents preferably have both frontmatter and backmatter, evenif there is no content in the frontmatter or backmatter. Further,depending on the style and preferences of the author of the document,normal frontmatter information may appear in backmatter or visa versa.For instance, the dates and parties in a contract are interchangeablyincluded either at the front of the document or at the back, dependingon the preferences of the author of the document.

In between frontmatter and backmatter is preferably the body of thedocument 215. The body of the document can be prose and can include amixture of arbitrarily ordered headings, outlines (sometimes calledlists), tables, and paragraphs as desired by the author. The body mayalso include graphics, pictures, and other objects (such, for example,as ActiveX controls).

In addition to the head and body, forms 210 and documents 215 mayoptionally include an XML signature. An XML signature is informationabout a digital signature and should be distinguished from a “signatureblock.” A signature block is viewable signature information that isusually included in backmatter. A signature block may include the namesof parties, titles, a typewritten signature (e.g., /Signature/) or agraphical signature (e.g., a bitmapped signature).

Vocabulary

Sprinkled randomly throughout the paragraphs, tables, and outlines inthe document body is vocabulary 260. For instance, in a contract, thereare names, price terms, conditions, and consideration. In transcriptsthere are questions, answers, witnesses, and exhibits. Different typesof documents 220 have different types of vocabularies 260. Not allvocabularies are available to all types of documents. Vocabularies 260are, therefore, modular based on individual schema.

In determining whether an element 250 is suitable as vocabulary 260, theschema framework 115 can distinguish between types of elements,including structural, data, and hybrid. A structural element is one thatrepresents the structure of a document, such a frontmatter, body,backmatter, paragraph, heading, outline, or table. A data element is onethat has some meaning to the human reader, such as, but not limited to,Name, Address, Time, Vehicle, and Consideration. Hybrid elements areelements that serve a structural purpose and are also data. For example,the title in a document is structural in that it conventionally comes atthe top of the document, somewhere in frontmatter. Title is also data,in that a title of a book could be extracted and taken out of itsstructural context and still have meaning. Data elements and hybridelements are preferably appropriate as vocabulary. Also preferably, purestructural elements are not appropriate as vocabulary. It should benoted that even data elements have structure when represented as XML.For example, an Address has within it (as children) address lines, city,state, postal code, and others.

Vocabulary 260 appears in the text portion of paragraphs, headings,outlines, and tables. The text element in each of these structures ispreferably “mixed” content, meaning that text can be arbitrarilysprinkled with elements within the text element. A vocabulary group canbe created in individual schemas. Each vocabulary group can be importedinto a vocabulary schema. A vocabulary group in the vocabulary schemacan be imported into an inline schema. The inline schema can createvarious groups of vocabulary and other elements that are imported intothe text element of paragraph, outline, heading, and table.

The creation of a vocabulary group in individual schemas can provide a“flatting” of any structure used by data elements. Structure ispreserved in the data elements that have content models, but byreferencing children, the children are made available through thevocabulary group for inserting into the text. In the preferredembodiment, these elements are called “inserted vocabulary elements”(“IVE”).

Vocabulary 260 is preferably collected by importing and referencing oneor more groups in a vocabulary schema. The vocabulary group can then beimported into the inline schema. The inline schema preferably includesother elements that are common to all documents.

The inline group can then be imported into each of the text elements ofparagraph, heading, outline, and table. A simple reference toInline:Inline makes available all of the vocabulary elements from all ofthe schema that are imported in the first step, which provides theability to create either a very specific vocabulary for a specificdocument type or a very extensive vocabulary for a more general orcomplex document type.

Schema Maintenance, Discovery, and Documentation

The schemas can be maintained over time and published so that interestedparties are able to discover schemas electronically. Preferably, theschemas are also documented. Preferably, the system 100 automaticallymaintains, discovers, and documents XML schema, in both a machine andhuman-readable format by publishing schema, documentation, datadictionaries, and indexed lists of schema in the schema repository. Forexample, a SchemaDescriptions.xsd file can be created such that it usesthe namespace prefix “lml” (for “Legal Markup Language”).

The Schema Repository

Preferably, there is a primary schema repository 120 that stores allschemas. Additionally, mirrored and/or local schema repositories canhold all or a subset of all schemas. It is also possible that severalschema repositories exist that are not full mirrors of each other butthat combined hold all schema. A block diagram of an exemplary schemarepository 120 is depicted in FIG. 3. In the preferred embodiment,schemas in the schema repository 120 are located as a web resource at aURI corresponding to the value of the schema's namespace with a filenamethat is the same as the intended root element and namespace prefix.Thus, the schema repository 120 can be accessed via HTTP, for example,although it is also possible to access schemas in repositories usingother protocols and in other directory structures.

The schema repository 120 is a directory structure that allows anyschema corresponding to any given arbitrary namespace or arbitraryinstance document (which would have a namespace within it) to bediscoverable and available. A schema is considered available even if itis password protected for security, privacy or other practical reasons.

The schema can also be available in mirrored or local repositories. Alsopreferably, the schema repository 120 can be portable from the local ormirrored schema repositories. Local schema repositories can be created,but preferably the schemas downloaded in the local schema repositorymatch exactly the schemas in the schema repository 120. If changes aremade locally to a non-frozen schema, then the schema can be uploaded tothe schema repository 120, and the old schema can be archived. If theschemas in the local schema repository does not match exactly theschemas in the schema repository 120, then the system may potentiallyencounter inoperability problems.

Mirrored schema repositories in either HTTP or FTP or other publiclyaccessible space can be created. Preferably, the mirrored schemarepository follows the same directory structure as the schema repository120 beginning with the directory “Schema”. Also preferably, the mirroredschemas are exact replicas of corresponding schemas once a schema isfrozen. If the schemas are not exact replicas, then the system 100 maypotentially not work correctly because the system 100 preferably hasdistributed schema repositories. In the preferred embodiment, creatingexact replicas of schemas in a mirrored repository can be done usingdigital signature technology, although other means are also within thescope of the present invention.

Optionally, the schema repository 120 can be password protected foraccess only by authorized users. Also, parts of the schema repository120 can be password protected for access by different groups of users,while parts of the schema repository 120 can be open for semi-private orpublic consumption. Thus, “sub-repositories” can be created within theschema repository 120. Each of these sub-repositories can be passwordprotected such that a select group of users is given access. Eachsub-repository can also have its own SchemaDescriptions.XML file. When auser navigates to that part of the schema repository 120, thesub-repository would preferably have the same or similar look, feel, andfunctionality as the schema repository 120, but only those schemas inthat part of the sub-repository would be available for searching andviewing. For example, the schema repository can have a firstsub-repository 305A and a second sub-repository 305B. The firstsub-repository 305A can have a security feature 310 that provides forpassword protection.

Also each sub-repository 305A and 305B can include a mailing list 315and its own document repository 320. Both the mailing list 315 and thedocument repositories 320 can be used in a workgroup environment wheremultiple users, including users across organizations, can work on a setof schema and documentation at once.

Preferably, the schema repository 120 has a user interface 325 thatallows the user to search the schema repository 120 and to view links toschemas in the repository. For example, the schema repository 120 canhave a user interface 325 that lists the schema namespace prefix, or the“genre” of schema and its associated schema namespace as a web address.By clicking on the web address, the user can view 335 the schema. Thelist of schema can be in alphabetical order based on the namespace.

Also, there can be a search box/field that allows the user to search fora particular schema based on its namespace prefix or by elements,attributes, or types within schemas. For example, if the user searchesthe term “Email”, all of the schema that have the string “Email” willappear in the browser, and the other schema will be sorted out. Lettersor partial words can also be searched.

In the schema repository 120, the user can also view a description 340of each schema. For example, if the user clicks on the schema prefix,the user can view a description of the schema. The schema descriptioncan provide an update history for the schema, including the name of theauthor and whether the schema, in its history, has been copied fromanother namespace. This historical record can be useful forunderstanding when and why changes were made to the schema and canprovide a means to trace the schema back in time. The schema descriptioncan also be available either within the schema or in an accompanyingdocumented schema.

The user can also view schema documentation 345 in the schema repository120. For example, the schema namespace is a hypertext link that can takethe user to either the schema documentation or to the schema itself, ifdocumentation is not available. Schema documentation can include, but isnot limited to, the schema namespace, the schema repository 120, theschema prefix, the elements, attributes, types, and imported schema inthe schema, and the change history. Also within the schemadocumentation, there is preferably a “Schema Repository Location” linkthat takes the user to the schema file itself. There can also be areference to a data dictionary and to a compressed (zip) file thatincludes all subschema of a complex, multi-level schema. Preferably, allschema documentation includes the same or substantially similarinformation in the same or substantially similar format, even though theschema documentation can include a variety of information in a varietyof formats.

Preferably, the schema documentation begins with a table of contents.Also preferably, the items in the table of contents are hypertext linksthat, when clicked, take the user to a description of the element,simpleType, imported schema, or other construct used in the schema.Preferably, each definition has a link that can take the user back tothe table of contents. The table of contents also includes a list ofimported schema. Imported schema are external, not internal, and theschema themselves can contain elements, attributes, simpleTypes,imported schema, and other constructs.

Through the user interface, the user can also download 350 schemapackages and view 355 data dictionaries. The data dictionaries can becreated from the schema and can provide a flat list of each term in asingle schema or in a set of schema along with a link from the element,attribute, or simpleType name to the definition in the online schemadocumentation as well as the data type and a link to the definition ofthe data type. The schema packages can be compressed (e.g., zipped)files that preserve the hierarchical directory structure and include allschema that are in a set of schemas. Thus, the schema packages providean easy way for a user to download the entire set of schema and unzip itinto a local repository while preserving the directory structure.

The schema repository 120 can be periodically updated by using a crawler360. The crawler 360 is a tool that allows an administrator to literally“crawl” the schema repository 120 and update the SchemaDescriptionXMLfiles, which are used to generate the interfaces and provide the searchcapability described earlier in this section. For example, the crawler360 can be a web-based tool.

The Schema Generator

Preferably, the schema generator 125 is an application that provides aninterface 405 for creating, editing, and building normalized schema. Tocreate 410 schema, the schema generator can preferably import 415 otherschema or import 420 data dictionaries. Also preferably, the schemagenerator 125 can provide a user interface 420 that allows a user tomanage schema, schema documentation and schema data dictionaries.Preferably, the schema generator 125 can do this by allowing a user toview schema 425; backup schema 430; copy schema and subschema 435;delete schema 440; document and annotate schema 445; and validate andnormalize schema 450. Additionally, the user can create schemadocumentation 455; create data dictionaries 460; package schema anddocumentation 465; publish 470 schema, schema documentation, schema datadictionaries, and schema packages into a schema repository 120; andfreeze schema 470.

To view schema, the user interface 405 can include a treeview and aschema properties window. In the treeview, there can be, for example,four tabs, “Repository,” “Schema,” “Imported Schema,” and “Copy.”Preferably, the schema properties window shows the properties of thelast opened schema. In an exemplary embodiment, the Repository tab opensby default. On the Repository tab, the schema generator 125 can providean interface into the local schema repository 120.

To open or view a schema 425, the user finds the schema in the schemarepository 120 by preferably using the directory menu. Then, the usercan select the schema file from the file menu. The user can open theschema in various applications, including but not limited to, the schemagenerator window, Internet Explorer, Notepad, or XML Spy.

Schema can also be documented 430 in the Repository tab. For example, adocument button can be located on the Repository tab so that when theuser clicks the button, the schema can be automatically documented. Theuser can add prose documentation to the schema either by editing theschema as a text file in another application, such as, for example, inNotepad or XML Spy, or the user can add prose documentation through theschema generator interface.

Also within the schema generator 125 is a feature to manipulate theschema 420. To validate and normalize schema 435, there can be twoadditional buttons: “Validate” and “Normalize.” Clicking on the Validatebutton validates the schema by using, for example, Microsoft MSXML 4.0parser. If the schema is not valid, the schema generator 125 can providea message that states (a) that the schema is not valid with an errormessage from MSXML; (b) whether or not the schema is well-formed; (c)whether or not the schema namespace is a valid namespace; and (d)whether, based on the namespace, the schema is located in a correctplace in the repository (if it is not located in a correct place, theschema may not import other schemas properly and may be invalid as aresult, but otherwise be a good schema).

Clicking on the Normalize button will normalize the schema based on theschema framework's practices and conventions. Because the schema isaltered during this processes and potentially changed, option boxes arepreferably used to allow the user to the instruct the schema generator125 whether or not to (a) back up the original schema; (b) over writethe original schema; and/or (c) document the new schema with an updateshowing the schema has been normalized.

Also preferably, the schema generator 125 can include a function toautomatically normalize schema by using a normalization algorithm. Inthe preferred embodiment, the algorithm functions such that an inputschema is transformed into another representation and then transformedfrom that new representation into a schema. The resulting schema shouldbe a valid schema, should follow the rules of the schema framework 115,and should validate the same instance documents as the original schema.

It is possible that the schema is a valid schema, such as a valid W3Cschema, but not a normalized schema. In this case, the schema generator125 attempts to fix the schema and put it into a normalized state. Ifthe schema generator 125 cannot do this, it provides some explanation.The user has the option of normalizing the schema without saving it ornormalizing the schema and saving it.

Schema can also be backed-up 440 in the schema generator 125. Forexample, a “Backup” button can exist on the Repository tab such thatwhen the user clicks the Backup button, the schema is automaticallybacked-up in a file that preferably includes the date and time.

Because the schema are preferably “frozen” after an instance documentbased on the schema has been published, it is useful to be able to copyschema 445 or groups of schema from one place in the schema repository120 to another place. Whether one schema or several schemas are copied,the schema generator 125 preferably copies the schema, changes thenamespaces in the schema as well as any imported namespaces, and thensaves the schema in its new location. The user can also specify wherethe copied schemas are to be stored. Groups of schemas can also becopied in substantially the same manner. Preferably, there is “CopySingle Button” and a “Copy All” button that the user can click to copy aschema and to copy all the schemas.

This ability to copy schemas is especially useful for forms anddocuments that change slightly from year-to-year or at other times. Anexact replica of the form can be copied, and then slightly modified inits new namespace. Because the form of the original schemas are uniquelyidentified by their namespace and the schemas preferably remain “frozen”in their places in the schema repository 120, it is possible to validatelegacy forms and documents created with the original schema, whileupgrading to a new form.

A schema that is open in the schema generator 125 can be edited 450.Clicking on the Schema tab can bring up a sliding tab interface thatshows elements, children, simpleTypes, and attributes. Elements,children, simpleTypes, and attributes can be added, edited, and/ordeleted. As new schema are opened in the application, the schemagenerator 125 stores element names, attribute names, simpleType names,documentation (if available) and other information in a Dictionary. Ifthe schema is an XML schema, the vocabulary is associated with anamespace, so that there is a history of where the term originated.Vocabulary from schemas that are not normalized schemas can also beimported into the Dictionary.

Most complex schema, such as messages, forms, and documents use many ofthe same “building block” schemas. It is often convenient to import“building blocks” or “primitives” from the schema repository 120 and usethose schemas as they are or with slight revision. Similar to theDictionary, the schema generator 125 has the ability to provide a picklist of existing schema and import user-selected schema directly fromthe schema repository 120 into a schema as it is being built. Forexample, if a form includes a “Witness”, it is possible to (a) create anelement named “Witness”, (b) import the “Person” schema (which importsinto it the Address, Email, and Phone schemas), and then (c) create theWitness type as “Person”.

The pick list of schemas is created from a SchemaDescriptions.XML filegenerated by the crawler. Because the schema repository 120 can besegregated and password protected and can contain multipleSchemaDescription.XML files, users of the schema generator 125 can begiven limited access to parts of the schema repository 120 for security,privacy, or other reasons. Once schema have been generated, copied,edited, normalized, and documented, both the schema and documentationcan be uploaded into the schema repository 120. This can be accomplishedby clicking on the schema and the documentation in the Repository taband clicking the Upload button.

Also within the user interface 405, the user can create schemadocumentation 455, create data dictionaries 460, package schema anddocumentation 465, publish schema 470, and freeze schema 475.

The Code Generator

Preferably, the code generator 130 has a user interface 505 which allowsthe user to generates code 510, generate a test project 515, andgenerate code documentation 520 from schema that, when compiled,provides a DOM-based (i.e., document object module based) applicationprogram interface (“API”) to the schema. The code generator 130generates code (or an API) that allows a programmer (or user) to easilyoutput XML instance documents 525 that validate against the schema. Thecode-generated code can also consume valid XML instance documents andprovide the data in the document to other applications from its API.Preferably, the API can save the XML instance document in the XMLdocument repository 160 in a consistent manner.

The code-generated code can be source code 530 or compiled code 535, forexample, and can be used in other applications, such as the editor,development kits, and applications created by third parties. The testproject can use the code-generated code and has in itself generatedcode. The code generated code and the test projects output instancedocuments. Instance documents created by code-generated code (or thetest project) can be stored in the document repository and used as inputfor the wizard, editor, viewer, and e-filing applications.

Preferably, the code generator 130 has a user interface 505 that issimple to use. For example, the user can select a normalized schema fromthe schema repository 120, can select an output location, and can selectvarious properties, such as to generate only code or to generate sourcecode or compiled code. Then, the user can click a button to generatecode. The code generated is a set of classes that, when run or compiled,provide a very quick and easy way of creating XML instance documentsthat validate against the schema, as compared to manually creating suchcode, which would require substantial time. Thus, the resulting code canbe used very easily within other code projects to output XML and consumeXML instance documents, and to make data within the documents availablethrough the API.

Preferably, the code generator 130 also creates a test project that usesthe code-generated source code 530 or compiled code 535 that outputs anXML instance document with dummy data. The resulting test project can beused to output XML with little user intervention except mapping datavalues to the code-generated API and assuring the logic of the data isconsistent with the rules of the schema.

Preferably, the code generator 130 can also send XML instance documentsover the Internet or other network using one of several standardprotocols, such as HTTP, FTP, SMTP, or SOAP.

The output XML instance document 525 can be compatible with the indexerand viewer 150 so that complex searches and reports can be generatedfrom a repository of XML instance documents. The API allows a user tooutput “Simple XML” or “Complex XML.” Both Simple XML and Complex XMLpreferably validates against the schema used to generate the code thatgenerated the instance document. Specifying “Simple XML” preferablygenerates XML using locally declared namespaces and no namespaceprefixes. Specifying “Complex XML” preferably generates XML using eitherglobally or locally declared namespaces and uses namespace prefixes.

The Wizard

The wizard 140 is designed to allow users to quickly and simply enterdata into a user interface 605 (that can be dynamically created by thewizard), create and edit XML messages and forms 610, create and edittemplates 615, and submit completed messages and forms to electronicfiling applications or other custom applications 620. Users of thewizard 140 need little or no knowledge of XML or other underlyingtechnologies. Users simply type data into a user interfaces to createthe XML message or form. When the form is completed, it is preferablysaved in a document repository 160.

Preferably, the wizard 140 is simple to use, supports multiple forms andmessages, supports submission of the forms and messages to electronicfiling applications or other custom applications for processing of theXML data, and supports automatic storage of XML forms and messages inthe document repository. Forms and messages can be created from anyschema following the normalization rules of messages or forms. Formsthat have stylesheets can be printed directly from the wizard 140. Formscan be viewed in html format, as for example in Internet Explorer orNetscape, in an Adobe PDF format, in a Rich Text Format (“RTF”), or inScalable Vector Graphic (“SVG”) format. Previously created documents canbe opened, edited, and resent to electronic filing applications or othercustom applications. Also, the wizard 140 can be configurable toautomatically distribute completed forms to multiple HTTP, FTP, or SMTPaddresses.

To reduce data entry into the forms, the user can create multipletemplates 615 from within the wizard 140 to hold frequently used data;the user can use the internal copy button to copy and reuse informationpreviously typed into the form into multiple other locations within theform; or the user can use the external copy button to copy and reuseinformation from outside data sources. Also, the wizard 140 can employ“perfect fit” technology to provide as much or as little space on theform for data of variable length.

The wizard 140 can work with both encrypted and unencrypted schema. Useof encrypted schema provides additional data security and integrity. Thewizard 140 is also compatible with the viewer 150 for complex searchesof the document repositories.

The wizard 140 provides users with a simple way to enter data into XMLforms. “Perfect Fit” form technology provides as much or as little spaceas needed on the form for data of variable length. Perfect Fittechnology works by combining the XML data and a stylesheet todynamically create the visible form. Whether there is one address orfive, all of the addresses will fit the space on the form. This is animprovement over paper forms and other electronic forms where a fixedspace is provided for variable length data and blanks must be filled.For example, if a traditional form provides space for four data items,but the user types in only one of those data items, then there is extraspace on the form for three items. Similarly, if the user has five itemsand there is only space for four, then the traditional form does nothave enough room and the user either has to type in the form margin orsome other free space, or the user has to add an addendum to the form.

Some forms can automatically be installed when the wizard 140 isinstalled. Other forms can be downloaded from the schema repository 120,or created by a user or an administrator using the schema generator 125or another XML Schema development tool. Preferably, the system 100 isconfigured to allow only the administrator to add forms to the wizard140, although it is within the scope of this invention to allow any userof the wizard 140 the ability to add and remove forms from the wizard140.

When forms are added to the system, the user can select “Simple XML” or“Complex XML” as the “Output format.” Both Simple XML and Complex XMLcan validate against the schema used to generate the wizard interfacesused for data entry. Specifying “Simple XML” preferably generates XMLusing locally declared namespaces and no namespace prefixes. Specifying“Complex XML” preferably generates XML using either globally or locallydeclared namespaces and will use namespace prefixes. The output locationis a location in the document repository where the resulting XMLinstance document can be saved. The user can select any output locationon any local or network drive for the document repository. Differentforms can be saved in different document repositories, if desired.

Each form can be stored as a file in the document repository 160, andthen subsequently accessed by a user or an application, by its uniqueform name, which preferably identifies the content of the form. Forexample, a form for a police complaint in New Hampshire can have theform name: “New Hampshire Police Complaint”. Preferably, characters thatare not permissible in filenames, such as colons or slashes, should notbe used. Stylesheets can also be applied to a form. The use of astylesheet is optional, but the stylesheet will enable the document tobe viewed in a human readable format. The form can also be identified byopening it and determining its namespace.

In the wizard 140, the user can select either a new document or a newtemplate. Preferably, a document is the default when the user firststarts the application, and preferably, the application will rememberthe last selection each time the wizard 140 restarts.

In the document, the user can choose which form to open by selecting theform name from the list of available forms. Preferably, when “NewDocument” is selected, a form will open with a data entry screen on top.The data entry interface is generated dynamically from the schema. Theform in the background is dynamically generated from the schema and thestylesheet. The wizard 140 can dynamically generate new interfaces basedon an arbitrary XML schema, provided the schema is normalized based onthe rules of the schema framework.

The wizard 140 understands the form based on the namespace of the XMLschema selected in the configuration. Schemas imported are understood aswell, as their namespaces will be present when imported. The wizardconfiguration file allows the administrator to select a schema and astylesheet and a form name for the form. The form name appears in thenew document window. In the background, the form is uniquely identifiedby its namespace. As a result, the wizard 140 can automatically generateinterfaces appropriate to the form based on the XML schema. Likewise,the stylesheet is created especially for data created by the XML schema,ensuring that it will work properly to render the data input andresulting XML.

Completed or partially completed forms can also be opened in the wizard140. Alternatively, forms can be opened directly from the documentrepository or from within the viewer. When opened, data in a saved formautomatically populates the data entry screens where the data can beedited or augmented. Because the XML document's namespace is preferablypresent in the XML document when it is saved, the wizard 140 can readthe namespace and locate the appropriate schema in the schema repository120. However, if the namespace is not present in the XML document (or ifthe namespace is incorrect or if the schema at the end of the namespaceshas changed), then the wizard 140 may not work properly and the system100 can fail. Thus, the wizard 140 can generate interfaces appropriateto the XML form and can populate the XML data automatically into theinterfaces.

Preferably, schema included in the wizard installation files areencrypted and packaged so that they cannot be easily altered. Thus,schema that are distributed are “frozen” from a technical perspective sothey are more difficult to alter.

The user interface for each form can differ depending on the schema andstylesheet used. The wizard 140 can use multiple screens and sub-screensto navigate through the data entry process. These screens correspond tothe hierarchy of the XML schema. The user is able to type in as littleor as much data as is necessary, as defined by the schema, for aparticular form. The user can enter data into a field by typing directlyinto that field. Some fields, for example “Create Date” or “CreateTime,” open a new pop up box where the user can enter data specific tothat field. There are a number of XML schema constructs that the wizard140 recognizes to create special controls in the interface. For example,combo boxes, or drop down lists, can be created based on specific schemaconstructs.

In the preferred embodiment, common controls (for the specific platform,programming language, or operating system, such as but not limited to,Windows, Linux, and Java) can be created based on the data type orconstruct in the schema. For example, simpleTypes with enumerations cancreate drop down boxes with lists. Strings (xsd:string) or integers(xsd:integer) with maxLength and minLength can create a text box thatallows specified length in characters. A simpleType named “Memo” cancreate a large, multi-line text box. Special constructs can exist forfont picker controls, radio buttons, check boxes, date and time pickers,and other controls.

The labels in the wizard 140 interface are preferably dynamicallygenerated from element and attribute names. Preferably, element andattribute names use no spaces. As a result, the wizard 140 searches forcombinations of lower case and uppercase letters (e.g., tN″ in“FirstName”) and adds a space in between the lower case and upper caseletter to create a dynamically generated label. Other ways of generatinglabels for interfaces based on the schema are also within the scope ofthe present invention

Thus, users can create any arbitrary schema, using for example theschema generator 125 and have the schema and its vocabulary appear inand create data entry screens in the wizard 140. For example, the wizard140 can automatically generate foreign language interfaces simply byusing schema that use foreign words for element and attribute names.

Within the user interface, the user can navigate through the fields byusing the mouse or the tab key and keystrokes, for example. “Previous”and “Next” buttons can be used to move between screens. Also, the usercan navigate through main screens and sub-screens. Sub-screens arescreens within screens. The relationship among screens reflects theParent/Child/Sibling relationships as defined by the XML schema. As aresult, it can be said that there are parent screens, children screens,which are screens on different levels, and sibling screens, which arescreens on the same level. Parent screens may have multiple childrenscreens. A child screen may itself be a parent screen and may havechildren.

“Choice screens” can be used to enable the user to choose an item fromamong a discrete number of items defined by the schema. For example,radio buttons can be used to allow the user to make a choice among theitems. Once the user chooses an item, then the user can input data. Oncethe user presses a Done button, the text beside the radio buttonpreviously chosen will preferably change to reflect that data has beeninputted.

The “Done” button can be used to save the data entered on the screen orsub-screen. If the user is in a sub-screen, the done button willpreferably return the user to a main screen or parent screen.

A “Cancel” button can be used to discard all new data entry for thatparticular screen and close the screen. If the user is working on asub-screen (e.g., a child screen) and presses cancel, the data enteredon that screen will preferably be cleared and the user will return tothe screen's parent screen. If the user presses cancel on a main screen,the entire form preferably will be closed and all previously entereddata will be discarded. Also preferably, if the user is editing datapreviously typed, the cancel button will not discard the data previouslytyped, but new data will not be saved.

A “Finish” button can be used to save all of the data entered as an XMLfile in the document repository. The location of the document repositoryis set in the wizard configuration. The Finish button also shows theuser a finished version of the form the user has just completed.Additionally, the Finish button can be configured to email the form asan attachment to the email addresses in the configuration and/or to callan external application, such as an electronic filing application, thatcan receive and process the form.

An “EFiling” button can be used to electronically file the form throughthe e-file module. Other buttons can be added to the user interface. Theother buttons can include, for example, copy, delete, save, printpreview, print, email, new form, all of which are generally known in theart. Also, arrow buttons can be used to add additional data in a field.Additionally, buttons can be defined within the wizard 140. For example,one button can be labeled “Create Complaint”, such that when it isclicked, a screen pops up for data entry. Alternately, a complaint formcan appear in the user interface.

The user of the wizard 140 can create and store various templates withinthe wizard 140. Templates can be useful when the user wishes to storefrequently used data in a form, so the user does not have to type thesame information repeatedly. For example, if the user has a form wherethe user always uses the user's address as the return address, then theuser could create a template with the user's address stored in it. Thetemplate can then be available to the user when the user creates a newdocument, which saves the user from typing in the address repeatedly.Thus, it can be much quicker to create and use templates for commondata. Combined with the copy button, duplicate data entry is reduced oreliminated, and the quality of data is high because mistakes are avoidedwhen retyping is avoided.

The wizard can receive as input an XML form or message created bycode-generated code. For example, a developer can use the API fromcode-generated code to put information from a backend database into anXML instance document based on a schema. The XML instance documentcreated from the code-generated code can then be opened in the wizardand edited as if the XML instance document were created in the wizard.

The Editor

The editor 145 is a word processor that can be used for editing thedocuments defined by the schema framework 115. Even a user unfamiliarwith XML and the underlying technology can quickly and easily operatethe editor 145. Preferably, the editor 145 automatically configuresitself based on the document type opened. Also preferably, the editor145 uses the wizard 140 internally to allow the user to edit data insidethe document without seeing the XML tags within the document. The editor145 has an authoring interface 705 that preferably uses “colorization”710, “tool tips” 715, and “keystrokes” 720 to show the author visuallywhere data elements and document parts are located within the document,rather than including tags within the text. This provides awhat-you-see-is-what-you-get (“WYSIWIG”) XML authoring environment.Additionally, the user can insert new vocabulary into the XML document.Moreover, the editor 145 is preferably compatible with the wizard 140and can be used in frontmatter, backmatter, and within paragraphs,outlines, tables, and headings in the body. The editor can include anelectronic filing button that passes documents to an electronic filingapplication.

Upon launching the editor 145, the user can create a new document, edita document, or create a document from a template. For example, the usercan search the document repository and open a document for editing.Preferably, the user interface of the editor 145 has the look and feelof standard word processing software.

However, unlike traditional word processing software, the top and bottomportions of the document (i.e., frontmatter and backmatter) arepreferably static forms. For example, if a user is typing informationinto the document frontmatter, and the user types the enter key or thespacebar key within a vocabulary item, the wizard tool will pop up andprovide the user an interface in which to type the information. Thus,unlike other word processing software, the enter key does not produce aline feed within frontmatter, backmatter, or a vocabulary item. However,when the user edits prose that is not vocabulary within paragraphs,outlines, and tables within the body of the document and types the enterkey, a line feed is created.

For example, document formats such as MS Word and Word Perfect create acompletely free-flowing document format where line feeds are insertedwhenever the enter key is used, creating a very flexible authoringenvironment with no fixed content. Document formats such as AdobePortable Document Format (PDF) are very static, rigid formats that allowa user to type data into blanks, but do not allow the free-form editingenvironment of a word processor. The editor uses a document format(defined by the schema framework) that tells the application that someparts of the document are fixed and not appropriate for line feeds,while other parts of the document are not fixed and are appropriate forfree-form editing such as editing in a word processor.

Preferably, the top and bottom of the document are authored much like adocument in the wizard 140 except that in addition to the wizardinterface, it is possible to type directly into the document, which issimilar to using a word processor or typing into a fill-in-the-blankelectronic form.

To enter data into the vocabulary in the document, the user can typeinto the interface, which is similar to using a word process or typinginto a fill-in-the-blank electronic form, or the user places the cursorinto a vocabulary field and clicks the enter key or the spacebar key.When the user does this, the wizard 140 launches. The user can alsoright click on the mouse to insert new vocabulary or edit existingvocabulary with the wizard 140. Once the wizard 140 opens, the user canthen type in information to fill the vocabulary. Some vocabulary items,for example “Name of Child” or “Address”, can open a pop up box wherethe user can enter data specific to that field. Other items, such as“Date” fields, can open a pop up box that allows the user to choose adate using a date picker control. Also, it should be noted that somevocabulary items can be edited, while other vocabulary items can remainunedited.

Alternately, the user can select a vocabulary field with the mouse (forexample, by left clicking the field) and then can type directly into thefield. The vocabulary placeholder (e.g. “[Enter Name of Child]”)preferably disappears, and the text the user types appears in its place.

Preferably, when the user moves the mouse over the text, or when thecursor is otherwise placed in the text, the area where the user canenter text changes color, which is a technique known as colorization710. As the user moves the mouse over vocabulary, different colorsindicate where pieces or chunks of vocabulary, clauses, and paragraphsexist in the document. In addition, a tool tip 715 can appear over thevocabulary, clause, or paragraph, which conveys to the user theinformation is within the document.

The user can also use the arrow keys to move between the differentfields, vocabulary, clauses, and paragraphs (“nodes”). In the preferredembodiment, keystrokes 720 are used in the user interface to movebetween the different nodes. For example, if the cursor is in front ofthe last character at the end of the first node, and the user clicks theright arrow key, the cursor will move one character to the end of thefirst node, adjacent to the second node. The first node will remaincolored. When the user clicks the right arrow key again, the first nodewill loose color and the second node will become colored, although thecursor will not move in the user interface. The color signifies to theuser that the content in the first node is no longer editable but thatthe content in the second node is editable. If the user clicks the rightarrow key a third time, then the cursor will move one character to theright. Thus, two keystrokes of the arrow keys allow the user to visuallymove between adjacent nodes (e.g., three right arrow key strokes resultin only two movements of the cursor when the cursor is at the boundaryof a node). This behavior is unlike other word processors. Combined withcolorization, this behavior enables the editor's WYSIWYG feature,because unlike other word processors, viewable markers are not requiredwithin the editable document.

When the user left clicks on a vocabulary place holder, for example“[Type County]”, and then types the text, the vocabulary placeholderdisappears. Vocabulary placeholders preferably use [brackets] and theword “Type” to indicate a blank vocabulary item within the document,which can be edited, although other textual cues could be used. Once theuser has entered information into the vocabulary item, the placeholderdisappears. If the user deletes all of the text in a vocabulary item, byusing the delete or backspace key, the vocabulary place holderpreferably reappears.

If the user has selected a vocabulary date field (i.e. “[Type Date]”)within a heading, paragraph, or outline, a date wizard can be used toenter the date. The date wizard can provide drop down lists of the day,month, and year, and then automatically create a date field in the XMLdocument.

Similar to the wizard 140 discussed herein, the editor 145 can also havea plurality of buttons, including, but not limited to, next, previous,cancel, done, and finish, to move between screens and to save, cancel,or manipulate data therein.

Also within the editor 145, the user can open, for example, a notepadapplication. The notepad has the look and feel of standard wordprocessing software, with various editing tools, toolbars, and pop-upmenus from the right click of the mouse. Within the notepad, the usercan create a new XML document. Within the document, the user can enterparagraph text by, for example, clicking on the “[Type paragraph]” fieldon the screen, and typing into it. Also, the user can select a featureto convert the paragraphs typed into an outline format. An outline is anindented and numbered area of text (similar to bulleted lists in a wordprocessor). Outlines can also be created directly within notepad.

In addition to adding paragraph text, the user can add headings to theparagraphs. The user can select the heading option from the toolbar orthe pop-up menu from the right click of the mouse to generate a newheading. Headings can be automatically numbered within the XML document.

The editor 145 has the ability to add and save “most used clauses” thatcan be automatically inserted into the XML document, including into theparagraphs, headings, and outlines. Thus, creating documents is quickand easy and reduces the number of errors by minimizing the data entryinvolved in re-keying. For example, a pop-up window or a menu can beused to store the “most used clauses” that can later be accessed by theuser by opening the window or menu.

The editor can configure itself to any document that follows the rulesof the schema framework 115. Preferably, buttons will appear on aleft-aligned toolbar that correspond to structural elements in the bodyof the document. For example, in a transcript, if question and answerstructural elements are defined by the schema in a document's body, thenbuttons that allow the user to insert a question and answer willpreferably appear on the left-aligned toolbar. Likewise, in a contract,if a clause structural element is defined by the schema, then a buttonthat allows the user to insert a clause will preferably appear on theleft-aligned toolbar.

The Document Repository

Preferably, the document repository 160 is a directory structure thatcan store the various documents and forms. Also preferably, the documentrepository 160 can be indexed and searched by the indexer and viewer150. Preferably, the directory structure is set of hierarchicaldirectories and subdirectories that are organized by a main directorydetermined by a user, with the first level of subdirectories named basedon the year in which an XML instance document is created, such as “2003”or “2004”; the second level of subdirectories named based on thenumerical month in which the XML instance document is created, such as“01” for January or “02” for February; and the third level ofsubdirectories named based on the day in which the XML instance documentis created. For example, an instance document created on Mar. 7, 2004,can be saved in a directory such as “MainDirectory/2004/03/03/.”

The Viewer and Indexer

The viewer and indexer 150 can search the document repository 160 basedon any of a variety of search parameters. The viewer and indexer 150 cansearch any field of each document in the document repository 160. Alsopreferably, the viewer and indexer 150 can automatically configureitself based on the rules of the schema framework. For example, theviewer and indexer 150 can automatically configure itself based on aninput schema to create a search term or a plurality of search terms thatcan be used to search the document repository 160 (and/or mirrored andlocal repositories) containing documents and forms created based on thesame input schema. If used with the e-filing module 155, electronicfilings and confirmations are also saved in the document repository 160and are easily and fully searchable using the viewer 150.

The E-Filing Module

The e-filing module allows the user of the system 100 to electronicallyfile the form or document with an electronic filing service provider.The module allows the user to send one or more documents to one or morerecipients in a manner similar to using electronic mail.

While the invention has been shown and described in preferred forms, itwill be apparent to those skilled in the art that many modifications,additions, and deletions can be made therein. These and other changescan be made without departing from the spirit and scope of the inventionas set forth in the following claims.

1. An apparatus for determining whether a markup language schema isnormalized, the apparatus comprising: logic configured to receive amarkup language schema and to determine whether the markup languageschema conforms to one or more rules of a schema framework rule set. 2.The apparatus of claim 1, wherein if the logic determines that themarkup language schema does not conform to the one or more rules, thenthe logic conforms the markup language schema to the one or more rulesof the schema framework.
 3. The apparatus of claim 1, wherein the logicfurther determines whether a markup language namespace associated withthe markup language schema conforms to the one or more rules of theschema framework rule set.
 4. The apparatus of claim 3, wherein themarkup language schema namespace is unique and identifies a unique markup language schema within the schema framework.
 5. The apparatus ofclaim 3, wherein the logic further determines whether the markuplanguage namespace includes a valid version number.
 6. The apparatus ofclaim 3, wherein the logic determines whether the markup languagenamespace conforms to the one or more rules of the schema framework ruleset by determining whether the markup language namespace includes auniform resource identifier (URI) and a category identifier, wherein thecategory identifier identifies a genre to which the markup languageschema associated with the markup language namespace relates.
 7. Theapparatus of claim 6, wherein the category identifier is selected fromthe group comprising a geographical region, a legal jurisdiction, anorganization, an institution, an industry, a department, an agency, atype of document, a type of form, a person, an address, a location and aplace.
 8. The apparatus of claim 1, further comprising logic forpublishing an instance document associated with the markup languageschema namespace.
 9. The apparatus of claim 8, further comprising logicfor freezing the markup language schema and the category identifier usedas the markup language schema namespace so that they can no longer bechanged or duplicated within the schema framework.
 10. The apparatus ofclaim 1, further comprising logic for freezing the markup languageschema so that it can no longer be changed.
 11. The apparatus of claim10, wherein once the markup language schema is frozen, all markuplanguage instance documents associated with the frozen markup languageschema are frozen such that they cannot be changed.
 12. The apparatus ofclaim 1, further comprising: logic for publishing a markup languageinstance document based on the markup language schema; and logic forfreezing the markup language schema, wherein once the publishing logicpublishes the markup language instance document, the freezing logicfreezes the markup language schema so that it cannot be changed.
 13. Theapparatus of claim 12, further comprising logic for storing the frozenmarkup language schema in a schema repository.